/projects/{projectId}/objects (Get)

Get	/projects/{projectId}/objects

In This Topic

Description

returns a list of objects in a project that satisfy the filter criteria

Parameters

Name	Description	Data Type
projectId	the id of the project to look in	string
skip	number of records to skip for pagination	integer (int32)
limit	maximum number of records to return	integer (int32)
ObjectID	provides a wild card string to filter objects by their objectId.	string
ClassID	Class ID for the object provides a wild card string to filter the object list by classId.	string
Description	provides a wild card string to filter objects by their description.	string

200 Response

The response body is of type ClassObjectResponse.

CimObjectInstance list results matching criteria

ClassObjectResponse

The results of the objects get query

Objects : Array[CimObjectInstance]

An array of the CimObjectInstance objects to create/update.

ID : string

is a string indicating the ID of the object

ClassID : string

is a string indicating the class of the object

Description : string

is a string indicating the description of the object instance

Attributes : Array[CimAttribute]

An array of attributes used in the configuration of the objects instance.

ID : string

is a string indicating the ID of the attribute

Value : string

is a string containing the value of the attribute.

Routing : Array[string]

An array of roles the alarms created by the this object are routed to

Fault Responses

Fault	Description
404	This fault returns a response body of type ProblemDetails. project with the given id is not registered on the system

Remarks

By passing a registered project id you can get a list of classes in this project